package org.xx.armory.spring5.mvc;

import org.springframework.core.annotation.AliasFor;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 标记此参数应当绑定到客户端地址。
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RemoteAddr {
    /**
     * 判断是否通过HTTP头部来获取客户端地址。
     *
     * @return 是否通过HTTP头部来获取客户端地址。
     */
    @AliasFor("value")
    boolean useHttpHeaders() default true;

    /**
     * 判断是否通过HTTP头部来获取客户端地址。
     *
     * @return 是否通过HTTP头部来获取客户端地址。
     */
    @AliasFor("useHttpHeaders")
    boolean value() default true;
}
